WORKERS AHEAD!

You are viewing the development documentation for the Apereo CAS server. The functionality presented here is not officially released yet. This is a work in progress and will be continually updated as development moves forward. You are most encouraged to test the changes presented.

To view the documentation for a specific Apereo CAS server release, please choose an appropriate version. The release schedule is available here.

Views

The views are found inside the CAS web application in the WEB-INF\lib\cas-server-support-thymeleaf-<cas.version>.jar in the templates folder. Add any views that require customization to the src/main/resources/templates folder in the CAS overlay project.
Any files found in that module can be overridden by putting them in the same location under src/main/resources in the CAS overlay project. The Gradle build script for the overlay has tasks that help get resources from the CAS web application to the correct location in the CAS overlay.

Templates

The following user interface templates are available and recognized by CAS for various modules and features:

Category	Name	Full Path
`acceptto`	`casAccepttoRegistrationView.html`	`/src/main/resources/templates/acceptto/casAccepttoRegistrationView.html`
`acct-mgmt`	`casAccountSignupView.html`	`/src/main/resources/templates/acct-mgmt/casAccountSignupView.html`
`acct-mgmt`	`casAccountSignupViewComplete.html`	`/src/main/resources/templates/acct-mgmt/casAccountSignupViewComplete.html`
`acct-mgmt`	`casAccountSignupViewCompleted.html`	`/src/main/resources/templates/acct-mgmt/casAccountSignupViewCompleted.html`
`acct-mgmt`	`casAccountSignupViewSentInfo.html`	`/src/main/resources/templates/acct-mgmt/casAccountSignupViewSentInfo.html`
`adaptive-authn`	`casRiskAuthenticationBlockedView.html`	`/src/main/resources/templates/adaptive-authn/casRiskAuthenticationBlockedView.html`
`admin`	`casAdminLoginView.html`	`/src/main/resources/templates/admin/casAdminLoginView.html`
`aup`	`casAcceptableUsagePolicyView.html`	`/src/main/resources/templates/aup/casAcceptableUsagePolicyView.html`
`authy`	`casAuthyLoginView.html`	`/src/main/resources/templates/authy/casAuthyLoginView.html`
`consent`	`casConsentView.html`	`/src/main/resources/templates/consent/casConsentView.html`
`delegated-authn`	`casDelegatedAuthnErrorView.html`	`/src/main/resources/templates/delegated-authn/casDelegatedAuthnErrorView.html`
`delegated-authn`	`casDelegatedAuthnStopWebflow.html`	`/src/main/resources/templates/delegated-authn/casDelegatedAuthnStopWebflow.html`
`delegated-authn`	`casDynamicDiscoveryView.html`	`/src/main/resources/templates/delegated-authn/casDynamicDiscoveryView.html`
`duo-security`	`casDuoLoginView.html`	`/src/main/resources/templates/duo-security/casDuoLoginView.html`
`error`	`error.html`	`/src/main/resources/templates/error.html`
`error`	`400.html`	`/src/main/resources/templates/error/400.html`
`error`	`401.html`	`/src/main/resources/templates/error/401.html`
`error`	`403.html`	`/src/main/resources/templates/error/403.html`
`error`	`404.html`	`/src/main/resources/templates/error/404.html`
`error`	`405.html`	`/src/main/resources/templates/error/405.html`
`error`	`423.html`	`/src/main/resources/templates/error/423.html`
`error`	`casServiceErrorView.html`	`/src/main/resources/templates/error/casServiceErrorView.html`
`error`	`casWebflowConfigErrorView.html`	`/src/main/resources/templates/error/casWebflowConfigErrorView.html`
`forgot-username`	`casForgotUsernameSendInfoView.html`	`/src/main/resources/templates/forgot-username/casForgotUsernameSendInfoView.html`
`forgot-username`	`casForgotUsernameSentInfoView.html`	`/src/main/resources/templates/forgot-username/casForgotUsernameSentInfoView.html`
`fragments`	`accepttoQRCode.html`	`/src/main/resources/templates/fragments/accepttoQRCode.html`
`fragments`	`footer.html`	`/src/main/resources/templates/fragments/footer.html`
`fragments`	`googleanalytics.html`	`/src/main/resources/templates/fragments/googleanalytics.html`
`fragments`	`header.html`	`/src/main/resources/templates/fragments/header.html`
`fragments`	`includes.html`	`/src/main/resources/templates/fragments/includes.html`
`fragments`	`loginProviders.html`	`/src/main/resources/templates/fragments/loginProviders.html`
`fragments`	`loginform.html`	`/src/main/resources/templates/fragments/loginform.html`
`fragments`	`loginsidebar.html`	`/src/main/resources/templates/fragments/loginsidebar.html`
`fragments`	`pmlinks.html`	`/src/main/resources/templates/fragments/pmlinks.html`
`fragments`	`pwdupdateform.html`	`/src/main/resources/templates/fragments/pwdupdateform.html`
`fragments`	`qrAuthentication.html`	`/src/main/resources/templates/fragments/qrAuthentication.html`
`fragments`	`recaptcha.html`	`/src/main/resources/templates/fragments/recaptcha.html`
`fragments`	`scripts.html`	`/src/main/resources/templates/fragments/scripts.html`
`fragments`	`serviceui.html`	`/src/main/resources/templates/fragments/serviceui.html`
`fragments`	`submitbutton.html`	`/src/main/resources/templates/fragments/submitbutton.html`
`fragments`	`webAuthnLogin.html`	`/src/main/resources/templates/fragments/webAuthnLogin.html`
`gauth`	`casGoogleAuthenticatorConfirmRegistrationView.html`	`/src/main/resources/templates/gauth/casGoogleAuthenticatorConfirmRegistrationView.html`
`gauth`	`casGoogleAuthenticatorLoginView.html`	`/src/main/resources/templates/gauth/casGoogleAuthenticatorLoginView.html`
`gauth`	`casGoogleAuthenticatorRegistrationView.html`	`/src/main/resources/templates/gauth/casGoogleAuthenticatorRegistrationView.html`
`gua`	`casGuaDisplayUserGraphicsView.html`	`/src/main/resources/templates/gua/casGuaDisplayUserGraphicsView.html`
`gua`	`casGuaGetUserIdView.html`	`/src/main/resources/templates/gua/casGuaGetUserIdView.html`
`interrupt`	`casInterruptView.html`	`/src/main/resources/templates/interrupt/casInterruptView.html`
`inwebo`	`casInweboBrowserAuthnView.html`	`/src/main/resources/templates/inwebo/casInweboBrowserAuthnView.html`
`inwebo`	`casInweboCheckResultView.html`	`/src/main/resources/templates/inwebo/casInweboCheckResultView.html`
`inwebo`	`casInweboErrorView.html`	`/src/main/resources/templates/inwebo/casInweboErrorView.html`
`inwebo`	`casInweboSelectAuthnView.html`	`/src/main/resources/templates/inwebo/casInweboSelectAuthnView.html`
`layout`	`layout.html`	`/src/main/resources/templates/layout.html`
`login-error`	`casAccountDisabledView.html`	`/src/main/resources/templates/login-error/casAccountDisabledView.html`
`login-error`	`casAccountLockedView.html`	`/src/main/resources/templates/login-error/casAccountLockedView.html`
`login-error`	`casAuthenticationBlockedView.html`	`/src/main/resources/templates/login-error/casAuthenticationBlockedView.html`
`login-error`	`casBadHoursView.html`	`/src/main/resources/templates/login-error/casBadHoursView.html`
`login-error`	`casBadWorkstationView.html`	`/src/main/resources/templates/login-error/casBadWorkstationView.html`
`login-error`	`casExpiredPassView.html`	`/src/main/resources/templates/login-error/casExpiredPassView.html`
`login-error`	`casMustChangePassView.html`	`/src/main/resources/templates/login-error/casMustChangePassView.html`
`login`	`casConfirmView.html`	`/src/main/resources/templates/login/casConfirmView.html`
`login`	`casGenericSuccessView.html`	`/src/main/resources/templates/login/casGenericSuccessView.html`
`login`	`casLoginMessageView.html`	`/src/main/resources/templates/login/casLoginMessageView.html`
`login`	`casLoginView.html`	`/src/main/resources/templates/login/casLoginView.html`
`logout`	`casConfirmLogoutView.html`	`/src/main/resources/templates/logout/casConfirmLogoutView.html`
`logout`	`casLogoutView.html`	`/src/main/resources/templates/logout/casLogoutView.html`
`logout`	`casPropagateLogoutView.html`	`/src/main/resources/templates/logout/casPropagateLogoutView.html`
`mfa-trusted-devices`	`casMfaRegisterDeviceView.html`	`/src/main/resources/templates/mfa-trusted-devices/casMfaRegisterDeviceView.html`
`mfa`	`casCompositeMfaProviderSelectionView.html`	`/src/main/resources/templates/mfa/casCompositeMfaProviderSelectionView.html`
`mfa`	`casMfaDeniedView.html`	`/src/main/resources/templates/mfa/casMfaDeniedView.html`
`mfa`	`casMfaUnavailableView.html`	`/src/main/resources/templates/mfa/casMfaUnavailableView.html`
`password-reset`	`casPasswordUpdateSuccessView.html`	`/src/main/resources/templates/password-reset/casPasswordUpdateSuccessView.html`
`password-reset`	`casResetPasswordErrorView.html`	`/src/main/resources/templates/password-reset/casResetPasswordErrorView.html`
`password-reset`	`casResetPasswordSendInstructionsView.html`	`/src/main/resources/templates/password-reset/casResetPasswordSendInstructionsView.html`
`password-reset`	`casResetPasswordSentInstructionsView.html`	`/src/main/resources/templates/password-reset/casResetPasswordSentInstructionsView.html`
`password-reset`	`casResetPasswordVerifyQuestionsView.html`	`/src/main/resources/templates/password-reset/casResetPasswordVerifyQuestionsView.html`
`passwordless`	`casPasswordlessDisplayView.html`	`/src/main/resources/templates/passwordless/casPasswordlessDisplayView.html`
`passwordless`	`casPasswordlessGetUserIdView.html`	`/src/main/resources/templates/passwordless/casPasswordlessGetUserIdView.html`
`protocol`	`casProxyFailureView.html`	`/src/main/resources/templates/protocol/2.0/casProxyFailureView.html`
`protocol`	`casProxySuccessView.html`	`/src/main/resources/templates/protocol/2.0/casProxySuccessView.html`
`protocol`	`casServiceValidationFailure.html`	`/src/main/resources/templates/protocol/2.0/casServiceValidationFailure.html`
`protocol`	`casServiceValidationSuccess.html`	`/src/main/resources/templates/protocol/2.0/casServiceValidationSuccess.html`
`protocol`	`casServiceValidationFailure.html`	`/src/main/resources/templates/protocol/3.0/casServiceValidationFailure.html`
`protocol`	`casServiceValidationSuccess.html`	`/src/main/resources/templates/protocol/3.0/casServiceValidationSuccess.html`
`protocol`	`casPostResponseView.html`	`/src/main/resources/templates/protocol/casPostResponseView.html`
`protocol`	`confirm.html`	`/src/main/resources/templates/protocol/oauth/confirm.html`
`protocol`	`deviceCodeApproval.html`	`/src/main/resources/templates/protocol/oauth/deviceCodeApproval.html`
`protocol`	`deviceCodeApproved.html`	`/src/main/resources/templates/protocol/oauth/deviceCodeApproved.html`
`protocol`	`sessionStaleMismatchError.html`	`/src/main/resources/templates/protocol/oauth/sessionStaleMismatchError.html`
`protocol`	`confirm.html`	`/src/main/resources/templates/protocol/oidc/confirm.html`
`protocol`	`casOpenIdAssociationSuccessView.html`	`/src/main/resources/templates/protocol/openid/casOpenIdAssociationSuccessView.html`
`protocol`	`casOpenIdServiceFailureView.html`	`/src/main/resources/templates/protocol/openid/casOpenIdServiceFailureView.html`
`protocol`	`casOpenIdServiceSuccessView.html`	`/src/main/resources/templates/protocol/openid/casOpenIdServiceSuccessView.html`
`protocol`	`user.html`	`/src/main/resources/templates/protocol/openid/user.html`
`radius`	`casRadiusLoginView.html`	`/src/main/resources/templates/radius/casRadiusLoginView.html`
`saml2-discovery`	`casSamlIdPDiscoveryView.html`	`/src/main/resources/templates/saml2-discovery/casSamlIdPDiscoveryView.html`
`simple-mfa`	`casSimpleMfaLoginView.html`	`/src/main/resources/templates/simple-mfa/casSimpleMfaLoginView.html`
`storage`	`casSessionStorageReadView.html`	`/src/main/resources/templates/storage/casSessionStorageReadView.html`
`storage`	`casSessionStorageWriteView.html`	`/src/main/resources/templates/storage/casSessionStorageWriteView.html`
`surrogate`	`casSurrogateAuthnListView.html`	`/src/main/resources/templates/surrogate/casSurrogateAuthnListView.html`
`swivel`	`casSwivelLoginView.html`	`/src/main/resources/templates/swivel/casSwivelLoginView.html`
`u2f`	`casU2fLoginView.html`	`/src/main/resources/templates/u2f/casU2fLoginView.html`
`u2f`	`casU2fRegistrationView.html`	`/src/main/resources/templates/u2f/casU2fRegistrationView.html`
`webauthn`	`casWebAuthnLoginView.html`	`/src/main/resources/templates/webauthn/casWebAuthnLoginView.html`
`webauthn`	`casWebAuthnRegistrationView.html`	`/src/main/resources/templates/webauthn/casWebAuthnRegistrationView.html`
`wsfed`	`casWsFedStopWebflow.html`	`/src/main/resources/templates/wsfed/casWsFedStopWebflow.html`
`yubikey`	`casYubiKeyLoginView.html`	`/src/main/resources/templates/yubikey/casYubiKeyLoginView.html`
`yubikey`	`casYubiKeyRegistrationView.html`	`/src/main/resources/templates/yubikey/casYubiKeyRegistrationView.html`

Configuration

The following settings and properties are available from the CAS configuration catalog:

_{The configuration settings listed below are tagged as Required in the CAS configuration metadata. This flag indicates that the presence of the setting may be needed to activate or affect the behavior of the CAS feature and generally should be reviewed, possibly owned and adjusted. If the setting is assigned a default value, you do not need to strictly put the setting in your copy of the configuration, but should review it nonetheless to make sure it matches your deployment expectations.}

_{The configuration settings listed below are tagged as Optional in the CAS configuration metadata. This flag indicates that the presence of the setting is not immediately necessary in the end-user CAS configuration, because a default value is assigned or the activation of the feature is not conditionally controlled by the setting value.}

cas.view.template-prefixes=

Comma separated paths to where CAS templates may be found. Example might be classpath:templates,file:/templates.

org.apereo.cas.configuration.model.core.web.view.ViewProperties.

Configuration Metadata

The collection of configuration properties listed in this section are automatically generated from the CAS source and components that contain the actual field definitions, types, descriptions, modules, etc. This metadata may not always be 100% accurate, or could be lacking details and sufficient explanations.

Be Selective

This section is meant as a guide only. Do NOT copy/paste the entire collection of settings into your CAS configuration; rather pick only the properties that you need. Do NOT enable settings unless you are certain of their purpose and do NOT copy settings into your configuration only to keep them as reference. All these ideas lead to upgrade headaches, maintenance nightmares and premature aging.

YAGNI

Note that for nearly ALL use cases, declaring and configuring properties listed here is sufficient. You should NOT have to explicitly massage a CAS XML/Java/etc configuration file to design an authentication handler, create attribute release policies, etc. CAS at runtime will auto-configure all required changes for you. If you are unsure about the meaning of a given CAS setting, do NOT turn it on without hesitation. Review the codebase or better yet, ask questions to clarify the intended behavior.

Naming Convention

Property names can be specified in very relaxed terms. For instance cas.someProperty, cas.some-property, cas.some_property are all valid names. While all forms are accepted by CAS, there are certain components (in CAS and other frameworks used) whose activation at runtime is conditional on a property value, where this property is required to have been specified in CAS configuration using kebab case. This is both true for properties that are owned by CAS as well as those that might be presented to the system via an external library or framework such as Spring Boot, etc. When possible, properties should be stored in lower-case kebab format, such as cas.property-name=value.S ettings and properties that are controlled by the CAS platform directly always begin with the prefix cas. All other settings are controlled and provided to CAS via other underlying frameworks and may have their own schemas and syntax. BE CAREFUL with the distinction. Unrecognized properties are rejected by CAS and/or frameworks upon which CAS depends. This means if you somehow misspell a property definition or fail to adhere to the dot-notation syntax and such, your setting is entirely refused by CAS and likely the feature it controls will never be activated in the way you intend.

Validation

Configuration properties are automatically validated on CAS startup to report issues with configuration binding, specially if defined CAS settings cannot be recognized or validated by the configuration schema. The validation process is on by default and can be skipped on startup using a special system property SKIP_CONFIG_VALIDATION that should be set to true. Additional validation processes are also handled via Configuration Metadata and property migrations applied automatically on startup by Spring Boot and family.

Indexed Settings

CAS settings able to accept multiple values are typically documented with an index, such as cas.some.setting[0]=value. The index [0] is meant to be incremented by the adopter to allow for distinct multiple configuration blocks.

CAS v1

The following settings and properties are available from the CAS configuration catalog:

cas.view.cas1.attribute-renderer-type=DEFAULT

Indicates how attributes in the final validation response should be formatted. Available values are as follows:

DEFAULT: Render attributes using CAS protocol suggestions.
VALUES_PER_LINE: Inline attribute value(s) on each line.

org.apereo.cas.configuration.model.core.web.view.Cas10ViewProperties.

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

CAS v2

The following settings and properties are available from the CAS configuration catalog:

cas.view.cas2.failure=protocol/2.0/casServiceValidationFailure

The relative location of the CAS3 failure view bean.

org.apereo.cas.configuration.model.core.web.view.Cas20ViewProperties.

cas.view.cas2.proxy.failure=protocol/2.0/casProxyFailureView

The relative location of the CAS2 proxy failure view bean.

org.apereo.cas.configuration.model.core.web.view.Cas20ProxyViewProperties.

cas.view.cas2.proxy.success=protocol/2.0/casProxySuccessView

The relative location of the CAS2 proxy success view bean.

org.apereo.cas.configuration.model.core.web.view.Cas20ProxyViewProperties.

cas.view.cas2.success=protocol/2.0/casServiceValidationSuccess

The relative location of the CAS2 success view bean.

org.apereo.cas.configuration.model.core.web.view.Cas20ViewProperties.

cas.view.cas2.v3-forward-compatible=true

Whether v2 protocol support should be forward compatible to act like v3 and match its response, mainly for attribute release.

org.apereo.cas.configuration.model.core.web.view.Cas20ViewProperties.

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

CAS v3

The following settings and properties are available from the CAS configuration catalog:

cas.view.cas3.attribute-renderer-type=DEFAULT

Indicates how attributes in the final validation response should be formatted. Available values are as follows:

DEFAULT: Render attributes using CAS protocol suggestions.
INLINE: Inline attribute name/value as XML attributes.

org.apereo.cas.configuration.model.core.web.view.Cas30ViewProperties.

cas.view.cas3.failure=protocol/3.0/casServiceValidationFailure

The relative location of the CAS3 success validation bean.

org.apereo.cas.configuration.model.core.web.view.Cas30ViewProperties.

cas.view.cas3.success=protocol/3.0/casServiceValidationSuccess

The relative location of the CAS3 success validation bean.

org.apereo.cas.configuration.model.core.web.view.Cas30ViewProperties.

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Externalized Views

Views also may be externalized outside the web application conditionally and individually, provided the external path via CAS settings. If a view template file is not found at the externalized path, the default one that ships with CAS will be used as the fallback.

Views may also be found using an external URL in CAS settings that is responsible to produce the full view body in the response. This URL endpoint will receive the available request headers as well as the following headers in its request:

Header
`owner`
`template`
`resource`
`theme`, if available
`locale`, if available

Upon a successful 200 status result, the response body is expected to contain the view that will be rendered by CAS.

The following settings and properties are available from the CAS configuration catalog:

cas.view.rest.url=

The endpoint URL to contact and retrieve attributes.

org.apereo.cas.configuration.model.core.web.view.RestfulViewProperties.

cas.view.rest.basic-auth-password=

If REST endpoint is protected via basic authentication, specify the password for authentication.

org.apereo.cas.configuration.model.core.web.view.RestfulViewProperties.

cas.view.rest.basic-auth-username=

If REST endpoint is protected via basic authentication, specify the username for authentication.

org.apereo.cas.configuration.model.core.web.view.RestfulViewProperties.

cas.view.rest.headers=

Headers, defined as a Map, to include in the request when making the REST call. Will overwrite any header that CAS is pre-defined to send and include in the request. Key in the map should be the header name and the value in the map should be the header value.

org.apereo.cas.configuration.model.core.web.view.RestfulViewProperties.

cas.view.rest.method=GET

HTTP method to use when contacting the rest endpoint. Examples include GET, POST, etc.

org.apereo.cas.configuration.model.core.web.view.RestfulViewProperties.

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Thymeleaf

CAS uses Thymeleaf for its markup rendering engine. Each template is decorated by layout.html template file, which provides a layout structure for the template’s content. Individual components optimized for re-use among multiple templates are stored in the src/main/resources/templates/fragments folder, and referenced by the templates in src/main/resources/templates.

Refer to the Thymeleaf documentation for more information on its use and syntax.

The following settings and properties are available from the CAS configuration catalog:

spring.thymeleaf.cache=true

Whether to enable template caching.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.check-template=true

Whether to check that the template exists before rendering it.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.check-template-location=true

Whether to check that the templates location exists.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.enable-spring-el-compiler=false

Enable the SpringEL compiler in SpringEL expressions.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.enabled=true

Whether to enable Thymeleaf view resolution for Web frameworks.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.encoding=UTF-8

Template files encoding.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.excluded-view-names=

Comma-separated list of view names (patterns allowed) that should be excluded from resolution.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.mode=HTML

Template mode to be applied to templates. See also Thymeleaf's TemplateMode enum.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.prefix=classpath:/templates/

Prefix that gets prepended to view names when building a URL.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.reactive.chunked-mode-view-names=

Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

spring.thymeleaf.reactive.full-mode-view-names=

Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

spring.thymeleaf.reactive.max-chunk-size=0B

Maximum size of data buffers used for writing to the response. Templates will execute in CHUNKED mode by default if this is set.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

spring.thymeleaf.reactive.media-types=

Media types supported by the view technology.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Reactive.

spring.thymeleaf.render-hidden-markers-before-checkboxes=false

Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.servlet.content-type=text/html

Content-Type value written to HTTP responses.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Servlet.

spring.thymeleaf.servlet.produce-partial-output-while-processing=true

Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties$Servlet.

spring.thymeleaf.suffix=.html

Suffix that gets appended to view names when building a URL.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.template-resolver-order=

Order of the template resolver in the chain. By default, the template resolver is first in the chain. Order start at 1 and should only be set if you have defined additional "TemplateResolver" beans.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

spring.thymeleaf.view-names=

Comma-separated list of view names (patterns allowed) that can be resolved.

org.springframework.boot.autoconfigure.thymeleaf.ThymeleafProperties.

# Whether to enable template caching.
# spring.thymeleaf.cache=true

# Whether to check that the template exists before rendering it.
# spring.thymeleaf.check-template=true

# Whether to check that the templates location exists.
# spring.thymeleaf.check-template-location=true

# Enable the SpringEL compiler in SpringEL expressions.
# spring.thymeleaf.enable-spring-el-compiler=false

# Whether to enable Thymeleaf view resolution for Web frameworks.
# spring.thymeleaf.enabled=true

# Template files encoding.
# spring.thymeleaf.encoding=UTF-8

# Comma-separated list of view names (patterns allowed) that should be excluded from resolution.
# spring.thymeleaf.excluded-view-names=

# Template mode to be applied to templates.
# spring.thymeleaf.mode=HTML

# Prefix that gets prepended to view names when building a URL.
# spring.thymeleaf.prefix=classpath:/templates/

# Comma-separated list of view names (patterns allowed) that should be the only ones executed in CHUNKED mode when a max chunk size is set.
# spring.thymeleaf.reactive.chunked-mode-view-names=

# Comma-separated list of view names (patterns allowed) that should be executed in FULL mode even if a max chunk size is set.
# spring.thymeleaf.reactive.full-mode-view-names=

# Maximum size of data buffers used for writing to the response.
# spring.thymeleaf.reactive.max-chunk-size=0B

# Media types supported by the view technology.
# spring.thymeleaf.reactive.media-types=

# Whether hidden form inputs acting as markers for checkboxes should be rendered before the checkbox element itself.
# spring.thymeleaf.render-hidden-markers-before-checkboxes=false

# Content-Type value written to HTTP responses.
# spring.thymeleaf.servlet.content-type=text/html

# Whether Thymeleaf should start writing partial output as soon as possible or buffer until template processing is finished.
# spring.thymeleaf.servlet.produce-partial-output-while-processing=true

# Suffix that gets appended to view names when building a URL.
# spring.thymeleaf.suffix=.html

# Order of the template resolver in the chain.
# spring.thymeleaf.template-resolver-order=

# Comma-separated list of view names (patterns allowed) that can be resolved.
# spring.thymeleaf.view-names=

Configuration Metadata

Be Selective

YAGNI

Naming Convention

Validation

Indexed Settings

Warning Before Accessing Application

CAS has the ability to warn the user before being redirected to the service. This allows users to be made aware whenever an application uses CAS to log them in. (If they don’t elect the warning, they may not see any CAS screen when accessing an application that successfully relies upon an existing CAS single sign-on session.) Some CAS adopters remove the ‘warn’ checkbox in the CAS login view and don’t offer this interstitial advisement that single sign-on is happening.

...
<input id="warn"
       name="warn"
       value="true"
       tabindex="3"
       th:accesskey="#{screen.welcome.label.warn.accesskey}"
       type="checkbox" />
<label for="warn" th:utext="#{screen.welcome.label.warn}"/>
...

Custom Fields

CAS allows on the ability to dynamically extend the login form by including additional fields, to be populated by the user. Such fields are taught to CAS using settings and are then bound to the authentication flow and made available to all authentication handlers that wish to impose additional processes and rules using said fields.

The following settings and properties are available from the CAS configuration catalog:

cas.view.custom-login-form-fields.[key].converter=

The id of the custom converter to use to convert bound property values.

org.apereo.cas.configuration.model.core.web.view.CustomLoginFieldViewProperties.

cas.view.custom-login-form-fields.[key].message-bundle-key=

The key for this field found in the message bundle used to present a label/text in CAS views.

org.apereo.cas.configuration.model.core.web.view.CustomLoginFieldViewProperties.

cas.view.custom-login-form-fields.[key].required=

Whether this field is required to have a value.

org.apereo.cas.configuration.model.core.web.view.CustomLoginFieldViewProperties.